home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
BBS Toolkit
/
BBS Toolkit.iso
/
maximus
/
maxid103.zip
/
MAXID.DOC
< prev
next >
Wrap
Text File
|
1993-01-30
|
31KB
|
707 lines
┌──────────────────────────────────────────────────────────────────────────┐
│ ██ ██ ████ ███████▄ Version 1.03 │
│ ████ ████ ██ ██ █ Featuring: * Caller-ID │
│ ██ ██ ██ ██ ██▀▀▀█ █ █ ██ ██ █ * Auto Name Login │
│ ██ █ ██ ██▄▄▄█ █▄▄▄█ ██ ██ █ * Auto Password Login │
│ ██ ██ ██ █ ▄▀ ▀▄ ██ ██ █ For use with Maximus BBS, │
│ ██ ██ ██ █ █ █ ████ ███████▀ and the Suprafax v.32b modem │
│ with J-Roms compatible with │
│ Copyright 1993 by Wayne Boyd Caller-ID │
│ FidoNet 1:153/763, OS/2 Net 81:980/763, ISKCONet 108:410/8 │
├──────────────────────────────────────────────────────────────────────────┤
│ Runs on OS/2 and DOS based systems. │
│ May also be used with some limitations on other BBS packages. │
└──────────────────────────────────────────────────────────────────────────┘
Table of Contents:
Disclaimer...................................Page 1
Minimum System Requirements..................Page 2
Description..................................Page 2
Description of Files.........................Page 4
Quick and Dirty Setup........................Page 4
Explanation of MaxID.CFG.....................Page 5
LOGFILE....................................Page 6
MODEMSTRING................................Page 6
AREACODE...................................Page 7
OUTPUT.....................................Page 7
USERBBS....................................Page 8
DISABLE_AUTOLOGIN..........................Page 8
LOADMAX....................................Page 8
BATCH......................................Page 9
ALLOWPASSWORD..............................Page 9
SpawnBBS Example.............................Page 9
Setting up Your Modem........................Page 9
Errorlevels..................................Page 10
Terms and Conditions of Use..................Page 10
Credits......................................Page 11
I borrowed the following disclaimer from RABITLOC.DOC, a fossil unlock
program for RandomAccess BBS, which, by the way, you don't need with this
program and isn't relevant to this discussion in the least.
STANDARD DISCLAIMER (I'm sure you've seen it before somewhere)
~~~~~~~~~~~~~~~~~~~
This product is meant for educational purposes only. Any resemblance to
real persons, living or dead is purely coincidental. Void where
prohibited. Some assembly required. List each check separately by bank
number. Batteries not included. Contents may settle during shipment. Use
only as directed. No other warranty expressed or implied. Do not use
while operating a motor vehicle or heavy equipment. Postage will be paid
by addressee. Subject to CAB approval. This is not an offer to sell
securities. Apply only to affected area. May be too intense for some
viewers. Do not stamp. Use other side for additional listings. For
recreational use only. Do not disturb. All models over 18 years of age.
If condition persists, consult your physician. No user-serviceable parts
inside. Freshest if eaten before date on carton. Subject to change
without notice. Times approximate. Simulated picture. No postage
necessary if mailed in the United States. Breaking seal constitutes
acceptance of agreement. For off-road use only. As seen on TV. One size
fits all. Many suitcases look alike. Contains a substaintial amount of
non-tobacco ingredients. Colors may, in time, fade. We have sent the
forms which seem to be right for you. Slippery when wet. For office use
only. Not affiliated with the American Red Cross. Drop in any mailbox.
Edited for television. Keep cool, process promptly. Post office will not
deliver without postage. List was current at time of printing. Return to
sender, no forwarding order on file, unable to forward. Not responsible
for direct, indirect, incidental or consequential damages resulting from
any defect, error or failure to perform. At participating locations
only. Not the Beatles. Penalty for private use. See label for sequence.
Substantial penalty for early withdrawal. Do not write below this line.
Falling rock. Lost ticket pays maximum rate. Your cancelled check is
your receipt. Add toner. Place stamp here. Avoid contact with skin.
Sanitized for your protection. Be sure each item is properly endorsed.
Sign here without admitting guilt. Slightly higher west of the
Mississippi. Employees and their families are not eligible. Beware of
owl. Contestants have been briefed on some questions before the show.
Limited time offer, call now to insure prompt delivery. You must be
present to win. No passes accepted for this engagement. No purchase
necessary. Processed at location stamped in code at top of carton.
Shading within a garment may occur. Use only in well-ventilated area.
Keep away from fire or flame. Replace with same type. Approved for
veterans. Booths for two or more. Check here if tax deductible. Some
equipment shown is optional. Price does not include taxes. No Canadian
coins. Not recommended for children. Prerecorded for this time zone.
Reproduction strictly prohibited. No solicitors. No alcohol, dogs, or
horses. No anchovies unless otherwise specified. Restaurant package, not
for resale. List at least two alternate dates. First pull up, then pull
down. Call toll free before digging. Driver does not carry cash. Some of
the trademarks mentioned in this product appear for identification
purposes only. Record additional transactions on back of previous stub.
This supersedes all previous notices.
MaxID Version 1.03 Page 1
MINIMUM SYSTEM REQUIREMENTS
~~~~~~~~~~~~~~~~~~~~~~~~~~~
To run this program you need the following system requirements:
o Maximus BBS 2.00 or greater either DOS or OS/2 version.... OR...
o If you don't run Maximus, you can still use this program with some
restrictions. See DISABLE_AUTOLOGIN in the "EXPLANATION OF
MAXID.CFG" section below.
o BinkleyTerm 2.50 or higher version. (Another mailer *might* work.
Might work with Frontdoor if you can get it to record all
the stuff that comes from the modem in the log file.)
o A Suprafax V.32B modem with J-Roms or other compatible modem that
supports Caller-ID
o A telephone company that supports Caller-ID or sometimes they call it
Call Display, and you have to tell them to activate it for
you. Caller-ID is not available in all areas with all phone
companies. Check with your phone company if it is available
in your area.
I will assume you have assembled all these toys together, and that you
have them all setup and working (no, I have NO intention of telling you
how to do that). Now I'll tell you what MaxID can do.
DESCRIPTION
~~~~~~~~~~~
This is a highly specialized program that does an *amazing* thing. I'm
going to tell you what this program does on my computer. I can't
guarantee it will do the same for you. If you don't have what it takes
to run this program, then I recommend you go and get what you need, even
if it means buying a Suprafax modem! You have never seen anything quite
like what this program does. It will dazzle the sysop and the callers
too. It may also eliminate the need for a call back verifier on your
BBS too.
Here, in a nutshell, are the three features of MaxID:
1) When a new caller logs on your bulletin board, your BBS can now tell
the caller in the logon sequence what his or her phone number is even
before the caller provides the BBS with his or her phone number. This
feature can be available to most BBS packages. This information is
sent by the phone company to the modem, the modem tells Binkleyterm,
Binkleyterm tells it's log files, and this program reads the
Binkleyterm Log file from the bottom up to find the information. No
need for a call back verifier since the caller can see you already
know his or her phone number.
This feature is called Caller-ID
2) For users who are already registered on your BBS, MaxID will identify
the callers phone number from the Binkleyterm log as supplied by the
modem, and will then search the Maximus USER.BBS file for a matching
phone number. If it finds a match, it will extract the callers name
MaxID Version 1.03 Page 2
from the user list and create a batch file to load Maximus with the
caller's name on the command line. The caller will simply discover,
upon logging on, that Maximus will present him or her with his or her
name. THIS FEATURE AND THE NEXT FEATURE ARE PRESENTLY ONLY AVAILABLE
TO USERS OF MAXIMUS BBS. Upon calling your BBS, the Maximus caller
will be greeted something like this:
Maximus v.2.01wb
Joe Duffy (Y/n)?
In other words, even without the caller typing in his or her name,
the BBS will mysteriously already know who they are just because of
the phone number they used to call the board. If the caller happens
NOT to be Joe Duffy, he can answer NO to the question above and
re-enter his name. This could happen if two people use the same
computer at the same phone number. All this will happen automatically
when your callers phone your BBS.
This feature is called "Auto Name Login".
3) Also specific to Maximus users, MaxID is capable of auto logging a
caller's password at the discretion of the caller. This is an
optional feature. If you enable this feature here, and if a caller
wants to have AutoLogin including his or her password, he/she would
simply have to add a ! as the first character of their password. To
deactivate this feature, they simply would need to remove the ! from
the first character of their password in the CHANGE menu. This gives
the option to the caller if they want AutoLogin to also include the
password, and they can decide if they want to take this risk.
Obviously someone who shares a computer/phone line with other members
of the same household or business would NOT want this, and they can
just omit the exclamation mark from the first character of their
password. But if someone has exclusive use of a computer and phone
line, they may want this feature implemented. In any case, I left the
SysOp in control (although I feel the sysop should let the caller
decide). If the SysOp does not want this feature of MaxID then he/she
can configure this program to disallow it. I recommend to allow the
callers to decide if they want it on an individual basis. It's their
password. Let them decide how to use it.
This feature is called "Auto Password Login".
DESCRIPTION OF FILES
~~~~~~~~~~~~~~~~~~~~
With this package are the following files. If you don't have them all,
you don't have an authorized version and you should get one. You can
always file request the latest version of MaxID from my board at Fidonet
1:153/763.
MAXID.EXE.............This is a DOS program. There's NO OS/2 version :-(
But don't worry! I run a purely OS/2 system
including Maximus/Binkleyterm/Squish, and this
program still works, does it's job seamlessly and
is perfectly okay to use. I'll explain it to you
as you read on. But for now, if you run an OS/2
mailer and an OS/2 BBS, you can still use this
MaxID Version 1.03 Page 3
program without problems even though it's a DOS
executable.
MAXID.CFG.............This is the configuration file for the MaxID
program. This is what you fiddle with to make
MaxID work. Use a vanilla ascii editor for this.
MAXID.DOC.............If you were really observant, you might have
noticed that this is the name of the document you
are presently reading.
AUTOLOG.MEC...........An explanation to your callers how to take
advantage of Auto Name Login and Auto Password
Login and possible risks involved in Auto Password
Login. Also explains to them how to activate and
deactivate Auto Password Login if the sysop has
allowed this feature. This is a Maximus MECCA file
and is not much use unless you operate a Maximus
BBS.
NOTFOUND.MEC..........A suggestion of how to take advantage of Caller-ID
when dealing with new callers. This is what I use.
You can change it around as you like. This is also
a Maximus MECCA file and not much use unless you
operate a Maximus BBS.
WHATSNEW.DOC..........These are the latest, greatest changes, updates and
bug fixes to MaxID over previous versions.
QUICK AND DIRTY SETUP
~~~~~~~~~~~~~~~~~~~~~
If you don't want to read all the nitty-gritty details of this program
and just want to get it going quickly on a Maximus system, this is what
you have to do. If you don't run Maximus, you are very limited what you
can do with this program. For non-Maximus users, please see the
DISABLE_AUTOLOGIN section below.
STEP ONE:
Copy the MECCA files (*.MEC) into your \max\misc directory and compile
them with MECCA.EXE. If you don't know how to do that, what are you
doing with this program??
STEP TWO:
Copy MAXID.EXE and MAXID.CFG anywhere you want. Might be convenient to
put them in your Maximus system directory (\max)
STEP THREE:
Edit MAXID.CFG with an ascii editor. A lot is explained in there and you
can get a feel for it right away. You *must* edit it or it will not work
properly. Go in there and look at it.
STEP FOUR:
Edit your batch file that loads Maximus. Remove the line that normally
calls Maximus and replace it with the following:
MAXID MAXID.CFG
MaxID Version 1.03 Page 4
or if you have MaxID in a different directory, then:
d:\path\MAXID d:\path\MAXID.CFG
NOTE FOR OS/2 USERS: It doesn't matter if you are running OS/2 and this
is a DOS program. Since the program is fast and does not access the
comport, it will not interfere with anything. OS/2 users must NOT use
"START" to run this program. It must be called directly from the command
line. It will start a brief DOS session, run the program, and return to
the OS/2 batch file without dumping the caller. Trust me. I wrote the
program, and I also run an OS/2 BBS.
In the line AFTER loading MaxID in your batch file, call the name of the
batch file that MaxID creates. This is configured in MAXID.CFG. By
default, MaxID will create BBS.CMD (for OS/2) and BBS.BAT (for DOS).
REM This is how you would do it for DOS
Call BBS.BAT %1 %2 %3 %4 %5 %6 %7 %8 %9
REM This is how you would do it for OS/2
Call BBS.CMD %1 %2 %3 %4 %5 %6 %7 %8 %9
NOTE: This is NOT where you load your BBS with all the switches. That's
done by putting all the switches in MaxID.CFG. The parameters %1 through
%9 SHOULD be in sequential order here, just like the way you see it
above.
STEP FIVE:
Create a Maximus menu option so the callers can see and read the
AUTOLOG.MEC file that you copied into \max\misc and compiled. I do it
off my main menu. The NOTFOUND.MEC file will be displayed to callers
when they first call into your BBS.
That's it.
EXPLANATION OF MAXID.CFG
~~~~~~~~~~~~~~~~~~~~~~~~
MaxID.CFG is the configuration file for MaxID. MaxID must be told the
name and location of this file on the command line in order for it to
function properly. The following is a detailed description of the
"keywords" in the configuration file.
All "keywords" must be present in the configuration file. None of them
should be commented out. Lines beginning with a semi-colon (;) in the
extreme left margin are considered comment lines and are ignored. The
file is not case sensitive and you may use any combination of upper or
lower case letters.
MaxID takes one and only one command line parameter. If this is not
supplied, it will not run. You MUST tell MaxID the location and filename
of the configuration file on the command line. See examples below.
Example 1: (how to load MaxID from the command line)
MaxID MaxID.cfg
MaxID Version 1.03 Page 5
Example 2: (how to load MaxID from the command line when MaxID is in
another subdirectory).
c:\batch\MaxID c:\batch\MaxID.CFG
KEYWORD explanation:
LOGFILE <drive:\path\filename.ext>
Defines the name and location of your Binkleyterm (or
other mailer?) log files. MaxID will read the log file from
the bottom backwards. This insures that even if the logfile
is very large, it will not take MAXID any longer to locate
the correct phone number of the incoming call than for a
short log file. MaxID extracts the incoming callers phone
number from this logfile as supplied by your modem and phone
company.
MaxID will not search backwards indefinitely. If it doesn't
find the phone number after searching back 20 lines, it will
assume the number is unavailable.
MODEMSTRING <string>
This keyword is provided for possible compatibility with
modems other than the Suprafax v.32b with J-Roms. <string> is
here defined as the characters that the modem sends prior to
the phone number. A snippet from BinkleyTerm's log files
might look like this:
# 25 Jan 15:21:43 BINK Ring
# 25 Jan 15:21:49 BINK Date = 0125
# 25 Jan 15:21:49 BINK Time = 1520
# 25 Jan 15:21:49 BINK Nmbr = 4310499
: 25 Jan 15:22:14 BINK Connect 2400
+ 25 Jan 15:22:14 BINK Spawning BBS
In this case <string> should be defined as Nmbr =
Do not put quotations around this string. Default for this
setting is MODEMSTRING Nmbr =
This is the string MaxID will look for in order to locate the
telephone number in the log file.
AREACODE <number>
This defines your area code. Usually, as the telephone
company sends it, caller-id for local calls does not include
the areacode. However the problem is that many callers have
put an areacode in their userfile when they registered, so
MaxID Version 1.03 Page 6
this would mean the two numbers would not match. Or it may go
the other way that caller-id may report the areacode and the
number in user.bbs does not contain an areacode. To fix this
problem, place the number of your areacode here. This will
cause MaxID to strip your areacode both from the Binkleyterm
log file and from the phone strings it finds in user.bbs to
find a match. NOTE: strings like () and - are automatically
ignored by MaxID and so make no difference whether they are
present or not present.
This keyword will not affect what is written in the callers
file which is untouched by this program.
OUTPUT <drive:\path\filename.BBS>
MaxID will create a file which can be read by Maximus
directly to display the callers phone number to the caller.
Put the path and name of this file after this keyword. The
file name should have .BBS as an extension. By default it
should normally be \max\misc\phone.bbs for Maximus users.
This file will contain only the phone number of the caller in
formatted form. For example, if the phone number in
BINKLEY.LOG was 4316260 then the phone number in the file
created by OUTPUT will appear as 431-6260. Similarly, if the
mailer log file gives the phone number as 6044316260, then
the number will appear in the OUTPUT file as (604)431-6260.
If the caller's number is unlisted or unavailable to the
phone company at the time the call was made, MaxID will write
the phone number as "unavailable." Note the period at the end of
the word, and the word also begins with a lower case letter.
Maximus sysops can take advantage of this file in MECCA files
by using the [link] token to display the phone number to the
caller.
Example:
The phone number you are calling from is [link]misc\phone
If the call is coming from 4316260 this will display to the
caller in the BBS as follows:
The phone number you are calling from is 431-6260
If the call is coming from an unlisted number it will display
to the caller in the BBS as follows:
The phone number you are calling from is unavailable.
USERBBS <drive:path\name.ext>
This is the name and location of your Maximus USER.BBS file
MaxID Version 1.03 Page 7
containing the users of your BBS. If you don't have one,
change it to NUL.
The default is USERBBS c:\max\user.bbs
DISABLE_AUTOLOGIN <Yes/No>
If you don't want to use any of the autologin features, but
simply want to use this program to utilize Caller-ID and show
that information in the bulletin board to the callers, you
can disable AutoLogin entirely. If you set DISABLE_AUTOLOGIN
to YES then the program will not search USER.BBS for a
matching phone number and name, and will not write a batch
file that can be called by you to enable autologin. In
otherwords, when DISABLE_AUTOLOGIN is set to YES then this
program functions as a simple caller-ID program that writes
the phone number found in the mailer log file to a single
disk file and that's all. This will cause the program to run
slightly faster of course, but effectively removes the
ability of Maximus to know the name of the caller.
This is also useful for compatibility with other BBS packages
that may not be able to load the caller's name and optional
password directly from the command line. In such cases, you
COULD use this program only for caller-ID which creates a
file that could be read from the BBS.
The default setting is "DISABLE_AUTOLOGIN No"
LOADMAX <string>
This is where you tell MaxID what your batch file normally
uses to load Maximus after a caller presses escape and exits
the mailer to load the BBS. You should normally copy the
string directly from your old batch file and place it here
after the LOADMAX keyword.
If, for example, your batch file normally loads Maximus like
this --
maxp max -b%2 -p%3 -t%4 -s%1 -n1 -z\pipe\maxsnoop
Then you would put this in MaxID.CFG:
LOADMAX maxp max -b%2 -p%3 -t%4 -s%1 -n1 -z\pipe\maxsnoop
Note: maxP is the OS/2 version of Maximus, which is what I
run over here.
BATCH <filename>
MaxID will create a batch file upon termination that should
be CALLed from your normal batch file. The name of the batch
MaxID Version 1.03 Page 8
file should go here. If you are running DOS you must append
the file name with .BAT and if you are running OS/2 software
then you must append the filename with .CMD
You can also include a drive and path statement to <filename>
if you wish to create the batch file in a different directory
other than the one where MaxID is running.
Note: You will still have to provide the BBS batch file with
command line parameters. See below how to call BBS.BAT or
BBS.CMD in the section entitled "Spawnbbs Example"
The default is BATCH bbs.cmd
If you are running DOS the default should be BATCH bbs.bat
ALLOWPASSWORD <YES/NO>
If you want to disable the ability of callers to take
advantage of Auto Password Login in addition to Auto Name
Login, then set ALLOWPASSWORD to NO. If you want to allow
callers to be able to decide themselves if they want it on an
individual basis, set this to YES.
Default: ALLOWPASSWORD YES
SPAWNBBS EXAMPLE
~~~~~~~~~~~~~~~~
If you run OS/2, like me, you use SPAWNBBS.CMD to load Maximus. Here's a
snippet of mine:
[SPAWNBBS.CMD]
cd \max
maxid maxid.cfg
call bbs.cmd %1 %2 %3 %4 %5 %6 %7 %8 %9
This is also applicable to DOS users, except obviously in that case it
would be spawnbbs.bat. Note that although MaxID is a DOS based
application, it can still be run under OS/2 and works fine here.
BBS.CMD (or BBS.BAT) is created by MaxID. If a matching phone number was
located in USER.BBS then MaxID will add the caller's name and optional
password to the command line string to load the BBS.
SETTING UP YOUR MODEM
~~~~~~~~~~~~~~~~~~~~~
I don't know how other modems do it, but the Suprafax v.32b modem with
J-Roms does it with an AT command. MaxID needs to have human readable
responses from the Caller-ID of the modem. The following "AT" command
activates this when entered or added to your Binkleyterm or other mailer
modem init string.
AT#CID=1
MaxID Version 1.03 Page 9
The next thing to be aware of is that the Caller-ID information comes
between the first and second ring, so Binkleyterm cannot answer the
phone right away. On the other hand if it waits TOO long, you will get a
lot of lost carriers. There is a delicate balance. In my binkley.cfg
I have the following answer string which seems to work quite well:
Answer ~~~ATA|
This causes Binkleyterm to wait just long enough to get the caller-id
information before answering the call.
ERRORLEVELS
~~~~~~~~~~~
If MaxID encounters problems, it exits with errorlevels that can be
captured with your batch file. This is a list of them:
errorlevel 4 .........cannot find next record in USER.BBS
EXPLANATION: Something is wrong with your USER.BBS
errorlevel 3 .........cannot find a file (i/o error).
EXPLANATION: A path or file name is wrong in the
configuration file.
errorlevel 2 .........The config file could not be found.
EXPLANATION: The command line parameter pointing to
the config file is incorrect.
errorlevel 1 .........You tried to run MaxID without a command line parameter.
EXPLANATION: MaxID has to be run with a command
line parameter that points to the configuration
file.
errorlevel 0 .........Normal termination. The program did it's thing okay.
TERMS AND CONDITIONS OF USE
~~~~~~~~~~~~~~~~~~~~~~~~~~~
You are not required to register MaxID unless you run MaxID in a
commercial environment or on a commercial BBS. If your BBS users require
to send you money for access to your system, then you are required to
send me $25.00 for a license to use this program. Otherwise, the program
is free, and no other registration is required.
However, anyone may choose to register the program, and those that
choose to do so should send a cheque or money order for $25.00 to the
address below. In response, you will receive a registration number. You
can enter this registration number in MaxID.CFG. There is no difference
in the way the registered version of MaxID behaves and the unregistered
version with one exception. The unregistered version writes the words
"MaxID (UnRegistered)" just below the telephone number in the OUTPUT
file (see MaxID.CFG for more information about this file). This is
removed in the registered version.
To Register this program please send me the following information:
MaxID Version 1.03 Page 10
1) Your Name, exactly as it will appear in MaxID.CFG
2) Your areacode string, exactly as it will appear in MaxID.CFG
You will receive a registration number which you can then enter in
MaxID.CFG. This registration number is a composite derived from the
information above as you supplied it to me. This will remove the
unregistered notice in the file created by the OUTPUT keyword in the
configuration file.
I may be reached in the following ways:
Send your registration information to:
Wayne Boyd
c/o Vipramukhya Swami
5462 S.E. Marine Drive
Burnaby, BC V5J 3G8
CANADA
I may also be reached in the following ways:
By Fidonet Netmail... 1:153/763
By OS/2 Netmail.......81:980/763
By BBS phone: (604)431-6260 1200,2400,9600,7200,12000,14000 bps.
CREDITS
~~~~~~~
I would like to thank Matt Ion for giving me some of the ideas for this
program. He also encouraged me to keep the Auto Password Login available
although I originally thought it should be left out. After all, why not?
Let the caller decide or at least the sysop if they want the feature. I
am using it here, and it's really nice. The callers love it too.
Wayne Boyd
Sita and the Ring (OS/2) BBS
Running Maximus (OS/2 version)
and BinkleyTerm (OS/2 version)
Needless to say, I also have a
Suprafax v.32b modem with J-Roms
One final note. If you don't believe this all works... call my BBS and
see for yourself. Although caller ID doesn't work here for callers
outside of Canada, you will still get the idea.
Hare Krishna!
MaxID Version 1.03 Page 11